home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / X11 / xearth-0.92 / README < prev    next >
Text File  |  1995-06-25  |  5KB  |  138 lines
  1. RCS $Id: README,v 1.13 1994/06/02 17:19:20 tuna Exp $
  2.  
  3. README file for xearth, version 0.92
  4. Kirk Lauritz Johnson <tuna@cag.lcs.mit.edu>
  5. 1 June 1994
  6.  
  7.  
  8. WHAT IS IT?
  9.  
  10.     Xearth sets the X root window an image of the Earth, as seen from
  11.     your favorite vantage point in space, correctly shaded for the
  12.     current position of the Sun. By default, xearth updates the
  13.     displayed image every five minutes; the time between updates can
  14.     be changed using either X resources or a command line
  15.     option. Xearth can also render directly into PPM and GIF files
  16.     instead of drawing in the root window; see the man page for
  17.     details.
  18.  
  19.     See the HISTORY file for a list of changes since versions 0.5 and
  20.     0.92.
  21.  
  22.  
  23. IMPORTANT!
  24.  
  25.     This version of xearth (version 0.92) is an evolution of the only
  26.     version(s) of xearth that I ever released (versions 0.5, 0.9, and
  27.     0.91). Unfortunately, some net.weenies chose to make some minor
  28.     mods (and introduce bugs!) and "release" a bogus version 0.6
  29.     without even notifying or consulting with me; this may be the
  30.     version of xearth that you are currently using.
  31.  
  32.     Some of the command line options supported in the bogus version
  33.     0.6 (e.g, those having to do with "geostatic") don't exist in this
  34.     version -- their functionality (and more!) is available through
  35.     other means. In addition, the meaning and syntax of some of the
  36.     xearth command line options have changed, so you should probably
  37.     give the new man page a good reading if things don't seem to be
  38.     working as you expect.
  39.  
  40.  
  41. MAJOR CAVEAT
  42.  
  43.     This version of xearth (version 0.92) supports both one- and
  44.     eight-bit framebuffers. Systems with other than one- and eight-bit
  45.     framebuffers are only "supported" (indirectly) to the extent that
  46.     xearth can generate PPM and GIF files that can be fed directly
  47.     into your favorite image viewer (e.g., xv, xloadimage).
  48.  
  49.  
  50. WHERE TO GET IT?
  51.  
  52.     The latest-and-greatest version of xearth should be available via
  53.     anonymous ftp from cag.lcs.mit.edu:/pub/tuna (or, for those web
  54.     surfers out there, via a link from the xearth WWW home page
  55.     http://cag-www.lcs.mit.edu/~tuna/xearth/index.html).
  56.  
  57.  
  58. NOTES
  59.  
  60.     If you are trying to build xearth under SunOS 4.x using /bin/cc,
  61.     make sure to read the section of the INSTALL file entitled
  62.     "BUILDING UNDER SUNOS 4.x" regarding a compiler bug.
  63.  
  64.     There are a number of improvements that I'd love to make, but I
  65.     really should be working on my thesis instead of hacking on this.
  66.  
  67.     The map information used in xearth was derived from the "CIA World
  68.     Data Bank II map database," as taken from some "cbd" files that
  69.     were apparently originally generated by Brian Reid at DECWRL.
  70.  
  71.     Running in the background on a Sun 4/110, xearth requires around
  72.     30 CPU seconds each time it redraws an image in the root window.
  73.     With the default time-between-redraws of 300 seconds, I hardly
  74.     even notice the extra CPU load. Your mileage may vary, of course,
  75.     especially on slower machines.
  76.  
  77.     The Graphics Interchange Format(c) is the Copyright property of
  78.     CompuServe Incorporated. GIF(sm) is a Service Mark property of
  79.     CompuServe Incorporated.
  80.  
  81.     Thanks to Jamie Zawinski for suggesting that I look at his
  82.     xscreensaver package for a good example of how to use the resource
  83.     and command line option parts of Xt; his code saved me piles of
  84.     lossage.
  85.  
  86.     Kudos to Jef Poskanzer for his excellent PBMPLUS toolkit.
  87.  
  88.  
  89. IDEAS FOR FUTURE WORK
  90.  
  91.     Support for other visual classes and depths.
  92.  
  93.     Better error recovery (better than "assert()", anyway).
  94.  
  95.     Add options/resources that specify colors other than the default
  96.     green, blue, red, white, and black.
  97.  
  98.     Add hooks for user-specified marker locations.
  99.  
  100.     Code for tracking real-life orbits ("-pos hubble").
  101.  
  102.     Support for supersampling/antialiasing.
  103.  
  104.  
  105. AUTHOR
  106.  
  107.     Kirk Johnson <tuna@cag.lcs.mit.edu>
  108.  
  109.     Patches, bug reports, and suggestions are welcome, although I
  110.     can't guarantee that I'll get around to doing anything about them
  111.     in a timely fashion.
  112.  
  113.  
  114. LEGAL STUFF
  115.  
  116.     Copyright (C) 1989, 1990, 1993, 1994 by Kirk Lauritz Johnson
  117.  
  118.     Portions of the xearth source code, as marked, are:
  119.      Copyright (C) 1989, 1990, 1991 by Jim Frost
  120.      Copyright (C) 1992 by Jamie Zawinski <jwz@lucid.com>
  121.  
  122.     Permission to use, copy, modify, distribute, and sell this
  123.     software and its documentation for any purpose is hereby granted
  124.     without fee, provided that the above copyright notice appear in
  125.     all copies and that both that copyright notice and this permission
  126.     notice appear in supporting documentation. The author makes no
  127.     representations about the suitability of this software for any
  128.     purpose. It is provided "as is" without express or implied
  129.     warranty.
  130.  
  131.     THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  132.     INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  133.     IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT
  134.     OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  135.     LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  136.     NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  137.     CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  138.